//
// FileStrainer
//
// Copyright (C) jextra.net.
//
//  This file is part of the Crack build system.
//
//  The Crack build system is free software; you can redistribute it 
//  and/or modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//
//  The Crack build system is distributed in the hope that it will be 
//  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with the Crack build system; if not, write to the Free
//  Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
//  02111-1307 USA.
//

package net.jextra.crack.type;

import java.io.*;
import java.util.*;

/**
 * <p>
 * A filter for files within a given root directory. This works differently than the standard
 * java {@link FileFilter} in that it works in reverse. Instead of passing this to the 
 * <code>{@link File.listFiles}</code> method, the rootDir is passed to the FileStrainer.
 * </p>
 * <p>
 * The reason that this is important is it is 'easier' for file recursion, which is a very common 
 * desire in build systems. In other words, given a 'root directory' this returns any files within 
 * that directory and sub-directories that meet the strainers criterion.
 * </p>
 */
public interface FileStrainer
{
    public Collection<File> getFiles( File rootDir );
}

